home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 1998 January / Macworld (1998-01).dmg / Shareware World / Comms & Internet / quickest-mirror-1.1 / QuickestMirror docs < prev    next >
Text File  |  1997-11-04  |  10KB  |  115 lines

  1. To report errors, suggestions, or whatever, send e-mail to fab@kagi.com.
  2. My Web site is at http://www.kagi.com/authors/fab/
  3.  
  4. Don’t bother copying the above data out of this document, for there are handier menu items inside my application (see Edit menu).
  5.  
  6. QuickestMirror™ documentation
  7.  
  8. The latest version of any program of mine is usually available on the Info-Mac and Umich archives and their mirrors.
  9.  
  10. This document has styles in it. You may view them with a text editor such as Tex-Edit by Tom Bender or Style (1.2.1 or later) by Marco Piovanelli, or Apple SimpleText by Tom Dowdy and who knows what else.
  11.  
  12. •    PURPOSE
  13. QuickestMirror lets you quickly and easily access data replicated (“mirrored”) on several Internet servers.
  14. Do you usually access information replicated on several Internet servers? If you are a Macintosh user, the answer is probably yes. Whether you are trying to download a program from the Info-Mac archives, to grab the latest stuff by Peter N Lewis, or to browse the Apple Developer World site, the information you are looking for is available on several servers.
  15. To solve the problem, I devised a new URL scheme that maps a single URL to a list of URLs. For instance:
  16. fab://ftp.stairways.com/stairways?
  17.  
  18. maps to:
  19. ftp://ftp.stairways.com/stairways/
  20. ftp://redback.cs.uwa.edu.au/%2fOthers/PeterLewis/
  21. ftp://sunsite.cnlab-switch.ch/software/mirror/peterlewis/
  22. ftp://ftp.amug.org/pub/peterlewis/
  23. ftp://ftp.share.com/pub/peterlewis/
  24. ftp://mirrors.aol.com/pub/peterlewis/
  25. ftp://ftp.happysize.co.jp/pub/peterlewis/
  26.  
  27. QuickestMirror will show an ordinary list, dynamically sorted so that the faster sites drift toward the top.
  28.  
  29. •    COMPATIBILITY ISSUES
  30. ◊    QuickestMirror can only be used under System 7 or later; if you try to start it up under older versions of the System you will get an error message.
  31. ◊    QuickestMirror requires InternetConfig (possibly 1.1 or later, although 1.4 or
  32. later is recommended). It also requires Open Transport 1.1.1 or later to assess network
  33. performance; MacTCP users will still be able to pick a server at random, which is better than a fixed selection.
  34. QuickestMirror requires a 68020 processor. If there is demand, I will build a 68000 version for separate distribution.
  35.  
  36. •    GENERAL INFO
  37. ◊    Backward compatibility: QuickestMirror transparently converts Info-Mac partial URLs such as those found in the Info-Mac Digests (“[Archived as...”) or within URL Manager (“/info-mac/...”), and Umich partial URLs (“/mac/...”) to standard fab URLs.
  38. ◊    Private mirrors: some sites restrict access to mirrors so that only subscribers can take advantage of them (one such instance is ftp.surfnet.nl). If you have access to a private mirror, you can add it to the QuickestMirror database using ResEdit. To add a private Info-Mac mirror, you would do the following:
  39. 1) create a new 'FABm' resource containing the newly added mirror site (keep the ID# that ResEdit assigns automatically, and leave the name blank):
  40. Scheme ftp://
  41. ResID 128 -- the ID for the “Info-Mac” 'POPm' resource
  42. Insert a new field by selecting the asterisks and choosing Resource:Insert New Field(s).
  43. 2) edit the 'POPm' 128 resource: add a new ResID with the ID number ResEdit assigned automatically at 1).
  44. ◊    Scripting support: there is no full Object Model support, but there’s enough to let you automate the most commonly used functions: geturl and fetchurl are fully supported. For instance:
  45.  
  46. tell application "QuickestMirror"
  47.     fetchurl ("fab://ftp.aladdinsys.com/pub?")
  48. end tell
  49.  
  50. returns
  51. {"ftp://ftp.aladdinsys.com/pub/", "ftp://amug.org/pub/contrib/aladdin/", "ftp://ftp.scruz.net/users/aladdin/public/"}
  52.  
  53. Also, I added the normalizeurl command to let people access the automatic conversion feature. (Note that geturl and fetchurl automatically perform this step.) This is a boon if you want to batch process old Info-Mac Digests with a script. So:
  54.  
  55. normalizeurl ("[Archived as /info-mac/text/tex-edit-plus-21.hqx; 676K]")
  56.  
  57. returns
  58. "fab://info-mac.org?text/tex-edit-plus-21.hqx"
  59.  
  60. QuickestMirror also supports Frontier Menu Sharing.
  61. ◊    Vremya support
  62. http://www.lava.net/~kirill/software/
  63. The Vremya application by Kirill Levchenko can set your Macintosh system clock accurately using version 1 of the Network Time Protocol as described in RFC 1059 by D. Mills.
  64. fab://ds.internic.net/rfc?rfc1059.txt
  65.  
  66. QuickestMirror stores a list of public Network Time servers via an experimental "x-ntp" URL notation. Of course Vremya does not currently support geturl events and the like, so I handle this as a special case.
  67. You can obtain the latest fat binary Vremya from:
  68. ftp://ftp.lava.net/pub/users/kirill/Vremya-latest.hqx
  69. ◊    You can launch QuickestMirror multiple times in a networking environment, as well as from a locked disk (CD-ROMs are welcome; by the way, if this application is included on one it would be nice to send me a complimentary CD).
  70.  
  71. •    SHORTCOMINGS in the current implementation
  72. ◊    Some sites (mirrors.aol.com for instance) are configured so as to reject attempts made by QuickestMirror to determine network performance (ICMP echo packets, that is). As a result, QuickestMirror will erroneously display these sites at the bottom of the list. This will be dealt with someday, but there is nothing I can do about this right now.
  73. ◊    Some (Info-Mac) sites may store items using MacBinary (.bin), as opposed to Binhex (.hqx) -- Walter Ian Kaye pointed this out long ago; this defeats the mirror scheme unless I include an additional field in the local database. Also, there is no way (short of connecting) to detect partial (Info-Mac) mirrors.
  74. ◊    QuickestMirror does not know in advance if you will be allowed to connect: if a remote site imposes a user limit (the highway has the best bandwidth, but you stop at the toll bar) or the link is broken you can go back to QuickestMirror, show the window, and pick the next best site.
  75. ◊    Joe Barwell urged me to download François Pottier’s Big Brother because he thinks our programs might cooperate for the benefit of all:
  76. http://pauillac.inria.fr/~fpottier/brother.html.en
  77. Of course usefulness would still be very limited because BB cannot check ftp links yet. Support for BB is incomplete, because I cannot tell BB to do the link check reporting. Unfortunately François is very busy studying, so these changes won’t happen soon. My proposal was as follows:
  78.  
  79. I've just mulled over the issue, and I'm not sure I can do the reporting myself without messing up the user interface.
  80. Joe Barwell just wrote me:
  81. -- begin quote
  82. It would perhaps be preferable for BB to display the link-checking (though then you'd probably want it to switch to frontmost for that), as the alternative is something like what François & Alco Blom have arranged for Alco's URL Manager Pro, in which the bookmark links displayed in URLM's window get a tick or cross or whatever beside them when one has asked BB to check them. This might be awkward for QM, though, in which case you would want to get BB to display the diagnosis (assuming François can/will cooperate!).
  83. -- end quote
  84.  
  85. Indeed, this would be awkward because my URL list is dynamically updated. I guess that the user would be hopelessly confused by those flipping ticks/crosses.
  86.  
  87. How about this:
  88.  
  89. [report all | report failures only | no report]  -- enumeration, default report all
  90.  
  91. [show diagnostic  boolean]  -- default false
  92.  
  93. •    DISCLAIMER
  94. ◊    “No warranties at all, either express or implied…” “All trademarks are held by their respective owners…” and all that stuff.
  95. This application should do no damage, but if it does then you will be on your own. Let me know of any bugs you run into, anyway.
  96.  
  97. •    THANKS TO…
  98. ◊  Dario Accornero, who granted permission to include a couple of sounds from his excellent “TheZone” arcade game (check out http://www.area.it/dappsoft/). Grazie!
  99. ◊  Joe Barwell, who provided with lots of useful comments, especially with regard to scripting, link checking, and more. Thanks mate!
  100. ◊  Professor Gianpiero Bussolin at the University of Torino taught me a mathematical technique that proved most useful when handling network code. (Although the original problem was completely different!)
  101. ◊  Bryan Christianson, of WhatRoute fame (check out http://crash.ihug.co.nz/~bryanc), without whom QuickestMirror wouldn’t probably exist: his technical expertise was a godsend from the outset. Thanks mate!
  102. ◊  Walter Ian Kaye sent me several thought-stimulating pointers. Thanks!
  103. ◊  Marten Kooistra, whose continued help grants him a round of grappa. :-)
  104. ◊  Alessandro Levi Montalcini, who found the time to give several useful suggestions.
  105. ◊  Jim Luther for his great MoreFiles library.
  106. ◊  Peter N Lewis & Quinn wrote the superb InternetConfig. (And much more…)
  107. ◊  Quinn’s Open Transport sample code and support on the Open Transport mailing list were invaluable.
  108. ◊  Rocco Moliterno put up with phone calls, not mentioning the system crashes.
  109. ◊  Masatsugu Nagata, who managed to find his usual share of bugs despite lacking Open Transport on his Macs.
  110. ◊  Alberto Ricci, for aesthetical suggestions regarding my icons, and beta testing.
  111. ◊  Paolo Sasso was very helpful, especially when I was bitten by the evil System Error #112.
  112. ◊  Giuseppe “Peppino” Ventura found lots of bugs as usual (a particularly nasty one shortly before release).
  113.  
  114. •    ENJOY YOURSELF,
  115. and remember that more and more shareware authors are going commercial or worse, going Windoze, because they receive almost nothing. If you don’t pay for good shareware software today, you are likely to pay much more in the future for exactly the same features, plus a nifty package, a good manual, and perhaps a copy protection scheme or a serial number; you know you don’t need the package, or the copy protection, and undoubtedly you will not want to waste your time reading manuals.